home *** CD-ROM | disk | FTP | other *** search
/ MacHack 1996 / MacHack 1996.toast / Hacks / Hacks ’90 / NET⁄Mac / Docs / BM Documentation.txt < prev    next >
Encoding:
Text File  |  1989-04-23  |  11.0 KB  |  331 lines  |  [TEXT/MSWD]

  1.  
  2.  
  3.  
  4.  
  5. i
  6.  
  7.  
  8.  
  9. BM Documentation    Page i
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33. BM User Manual
  34.  
  35. Dave Trulli, NN2Z
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43. Table of Contents
  44.  
  45. 1.    What is BM ?    1
  46. 2.    BM Installation    1
  47. 2.1    Directory Structure    1
  48. 2.2    Configuration Files    1
  49. 2.2.1    The \bm.rc file    1
  50. 2.3.1    The\alias file    3
  51. 2.3.2    \spool\mqeue\sequence.seq    4
  52. 2.4    Enviornment    4
  53. 3.    Commands    4
  54. 3.1    Main Menu Commands    4
  55. 3.2    Text input commands    7
  56. 4.    Mailer Operation    8
  57. 4.1    Command Line Options    8
  58. 4.2    Sending Mail    8
  59. 4.3    Reading Mail    8
  60. 5.    BM/SMTP Interface    8
  61. 5.1    File Formats    8
  62. 6.    Bug Reports    8
  63.  
  64. .c1.1.    What is BM ?
  65.  
  66. BM is designed to serve as the mail user-interface for the KA9Q TCP/IP inter-networking package.  It provides a full set of mail services to the user which allows the sending and receipt of electronic mail.
  67.  
  68.  
  69. .c1.2.    BM Installation
  70.  
  71. To install BM requires the modification of the supplied configuration files and the creation of the proper directory structure.  The following sections describe the file and directory structure used by BM and SMTP.
  72.  
  73.  
  74. .c2.2.1    Directory Structure
  75.  
  76. \spool\mqueue    This directory holds the outbound mail jobs for SMTP.  Each job consists of 2 files a xxxx.txt and xxxx.wrk file where xxxx is a unique numerical prefix.  The format of the files are described in a later section.
  77.  
  78. \spool\rqueue    This directory is used by SMTP for jobs that have been received and will be processed by a user defined mail routing program.  This directory is not used directly by BM.
  79.  
  80. \spool\mail    This directory holds the individual mailboxes for each user name on your system.  The extension .txt is add to the user name to form the mailbox name.  Mail received by the SMTP server is appended to the mailbox file.
  81.  
  82.  
  83. .c2.2.2    Configuration Files
  84.  
  85.  
  86. .c3.2.2.1    The \bm.rc file;.  The \bm.rc file provides BM with the configuration needed for the operation of the mailer.
  87.  
  88. The format for the \bm.rc file is:
  89.  
  90. variable <space> value <newline>
  91.  
  92. The following variables are valid in the bm.rc file:
  93.  
  94. smtp <mail path>
  95.  
  96. defines the path to the directory containing the mailbox files.  The default directory is \spool\mail on the current drive.
  97.  
  98. host <your host name >
  99.  
  100. Is used to set the local hostname for use in the RFC822 mail headers.  This is a required field.
  101.  
  102. user <user name>
  103.  
  104. Defines the user name of the person who is sending mail.  This is also used as the default mailbox for reading mail.  On the AMPRNET this is usually set to your call.  There is a DOS limit of 8 characters for the user name.
  105.  
  106. edit <path of your editor>
  107.  
  108. Defines the name of your favorite editor which can be used to construct and edit the text of outgoing messages.  The use of edit is optional.
  109.  
  110. fullname <your full name>
  111.  
  112. Is used to provide your full name to the mailer for use in the comment portion of "From:" header line.  The use of fullname is optional.
  113.  
  114. reply <return address>
  115.  
  116. Defines the address where you wish to receive replies to messages sent.  This option is useful if you are operating your pc on a local area network and would like your mail replies sent to a more "well known host".  The address specified by reply is used to generate a "Reply-To:" header in outbound mail.  The "Reply-To:" header overrides the "From:" header which is the address normally used to reply to mail.  This field is optional.
  117.  
  118. maxlet <number of messages>
  119.  
  120. defines the maximum number of messages that can be processed by BM in one mailbox file.  The default value of maxlet is 100.
  121.  
  122. mbox <filename>
  123.  
  124. Specifies the default file to be used for the "save" command.  This file is in the same format as a mailbox and may later be viewed using the -f option of BM.  If this option is not used then the default is set to mbox.
  125.  
  126. record <filename>
  127.  
  128. If defined a copy of each message sent will be saved in <filename>.
  129.  
  130. folder <directory name>
  131.  
  132. If defined folder contains the path used by the save command.
  133.  
  134. screen [bios | direct]
  135.  
  136. In the Turbo-C compiled version of BM, screen sets the display output mode to use either direct writes to screen memory or the ROM BIOS.  The default is direct which provides the fastest output mode.  If you are using a windowing system such as Desqview you should set the mode to bios.
  137.  
  138. Here is a sample bm.rc file.
  139.  
  140. host nn2z.ampr
  141. user nn2z
  142. fullname Dave Trulli
  143. # send my replies to the Sun
  144. reply nn2z@ka9q.bellcore.com
  145. screen  direct
  146. edit /bin/vi
  147. mbox c:/folder/mbox
  148. record c:/folder/outmail
  149. folder c:/folder
  150. maxlet 200
  151.  
  152.  
  153.  
  154. .c3.2.3.1    The\alias file; The alias file provides an easy way to maintain mailing lists.  An alias can be any string of characters not containing the "@" symbol.  The format for the alias file is:
  155.  
  156. alias   recip1 recip2 recip3
  157. <tab>   recip4
  158.  
  159. Note that a long list of aliases can be continued on an additional line by placing a tab or space on the continuation line.
  160.  
  161. Some examples aliases are:
  162.  
  163. dave  nn2z@nn2z.ampr
  164.  
  165. phil  karn@ka9q.bellcore.com
  166.  
  167. # mail to local nnj users
  168. nnj  wb2cop@wb2cop.ampr karn@ka9q.bellcore.com
  169.   wb0mpq@home.wb0mpq.ampr w2kb@w2kb.ampr ka2tsm@ka2tsm.ampr
  170.  
  171. In the above example, when specifying nnj as the recipient, BM will expand the alias into the list of recipients from the alias file.  At this time an alias may not contain any other aliases.
  172.  
  173.  
  174. .c3.2.3.2    \spool\mqeue\sequence.seq;  The sequence file maintains a message counter which is used by BM and SMTP to generate message id's and unique filenames.  This file is created by BM.
  175.  
  176.  
  177. .c2.2.4    Enviornment
  178.  
  179. The timezone used in mail headers is obtained from the DOS environment variable TZ.  An example TZ setting is:
  180.  
  181. set TZ=EDT4
  182.  
  183. It is set in your AUTOEXEC.BAT file.  The first 3 characters are the timezone and the fourth character is the number of hours from GMT time.  If TZ is not set, GMT is assumed.
  184.  
  185.  
  186. .c1.3.    Commands
  187.  
  188. All BM commands are single letters followed by optional arguments.  The command list has been designed to make those familiar with Berkeley mailers comfortable with BM.
  189.  
  190.  
  191. .c2.3.1    Main Menu Commands
  192.  
  193. m [ userlist ]
  194.  
  195. The mail command is used to send a message to one or more recipients.  All local recipient names ( those which don't contain an '@' ) are checked for possible aliases.  If no arguments are supplied you will be prompted for a recipient list.  While entering a message into the text buffer several commands are available such as: invoking an editor, and reading in text from other messages or files.  See the section below for a description of these commands.  To end a message enter a line containing a single period.
  196.  
  197. It is important to remember that the input line buffer has a 128 character limit.  You should format your text by entering a carriage return at the end of each line.  Typing excessively long lines may cause data loss due to truncation when passing the message through other hosts.  Keeping lines less than 80 characters is always a good idea.
  198.  
  199. d [ msglist ]
  200.  
  201. Mark messages for deletion.  Messages marked for deletion are removed when exiting BM via the q command or when changing to an alternate mailbox with the n command.
  202.  
  203. h
  204.  
  205. Display message headers.  The message headers contain the message number, the status indicating whether it has been read or deleted, the sender, size, date, and subject.
  206.  
  207. u [ msglist ]
  208.  
  209. Undelete a message that is marked for deletion.  The status of a message can be determined by looking at the status field of the message using the h command.
  210.  
  211. n [ mailbox ]
  212.  
  213. Display or change mailbox.  The n command with no arguments will display a list of mailboxes containing mail.  If an argument is supplied, then the current mailbox is closed and a new mailbox is opened.
  214.  
  215. ! cmd
  216.  
  217. Run a DOS command from inside BM.  An error message will result if there is not enough memory available to load the command.
  218.  
  219. ?
  220.  
  221. Print a help menu for BM commands.
  222.  
  223. s [ msglist ] [ file ]
  224.  
  225. The s command is used to save messages in a file.  If no filename is given the default from the mbox variable in \bm.rc is used.  If no message number is supplied then the current message is saved.  The message is stored in the same format as a mailbox file with all mail headers left intact.
  226.  
  227.  
  228. p [ msglist ]
  229.  
  230. The p command is used to send messages to the printer.  This command uses the DOS device PRN for output.  This command is equivalent to:
  231.  
  232. s [ msglist ] PRN
  233.  
  234. w [ msglist ] file
  235.  
  236. The w command is used to save messages in a file.  Only the message body is saved.  All mail headers are removed.  If no message number is supplied then the current message is saved.
  237.  
  238. f [ msg ]
  239.  
  240. The f command is used to forward a mail message to another recipient.  If no message number is supplied the current message is used.  The user is prompted for the recipients and a subject.  The RFC822 header is added to the message text while retaining the complete original message in the body.  Also see the ~m command.
  241.  
  242. b [ msg ]
  243.  
  244. Bounce a message.  Bounce is similar to forwarding but instead of your user information, the original sender information is maintained.  If no message number is supplied the current message is used.
  245.  
  246. r [ msg ]
  247.  
  248. Reply to a message.  Reply reads the header information in order to construct a reply to the sender.  The destination information is taken from the "From:" or the "Reply- To:"header, if included.  If no message number is supplied the current message is used.
  249.  
  250. msg #
  251.  
  252. Entering a message number from the header listing will cause the message text to be displayed.
  253.  
  254. l
  255.  
  256. List outbound messages.  The job number, the sender, and the destination for each message is displayed.  A status of "L" will appear if the SMTP sender has the file locked.
  257.  
  258.  
  259. k [ msglist ]
  260.  
  261. Remove an outbound message from the mqueue.  A message can be removed from the send queue by specifying the job number obtained by the l command.  If the message is locked you will be warned that you may be removing a file that is currently being sent by SMTP.  You will asked if this job should still be killed.
  262.  
  263. $
  264.  
  265. Update the mailbox.  This command updates the mailbox, deleting messages marked for deletion and reading in any new mail that may have arrived since entering BM.
  266.  
  267. x
  268.  
  269. Exit to DOS without changing the data in the mailbox.
  270.  
  271. q
  272.  
  273. Quit to DOS updating the mailbox.
  274.  
  275.  
  276. .c2.3.2    Text input commands
  277.  
  278. The following commands are available while entering message text into the message buffer.
  279.  
  280. ~r <filename>    read <filename> into the message buffer.
  281.  
  282. ~m <msg #>    read <msg #> into the message buffer.
  283.  
  284. ~p    display the text in the message buffer.
  285.  
  286. ~e    invoke the editor defined in \bm.rc with a temporary file containing the text in the message buffer.
  287.  
  288. ~q    Abort the current message.  No data is sent.
  289.  
  290. ~~    Insert a single tilda character into the message.
  291.  
  292. ~?    Display help menu of tilda escape commands.
  293.  
  294.  
  295.  
  296. .c1.4.    Mailer Operation
  297.  
  298. .c2.4.1    Command Line Options
  299.  
  300. BM may be invoked as follows:
  301.  
  302. To send mail:
  303. bm [ -s subject ] recip1 ..  ..  recipN
  304.  
  305. To read mail:
  306. bm [ -u mailbox | -f file ]
  307.  
  308. -s subject    This option sets the subject to the text on the command line.
  309.  
  310. -u mailbox    Specify which mailbox to read.  This overides the default from the bm.rc.
  311.  
  312. -f file    Read message from "file" instead of a mailbox.
  313.  
  314. .c2.4.2    Sending Mail
  315.  
  316. .c2.4.3    Reading Mail
  317.  
  318. .c1.5.    BM/SMTP Interface
  319.  
  320. .c2.5.1    File Formats
  321.  
  322. .c1.6.    Bug Reports
  323.  
  324. Please send any comments, suggestions or bug reports to:
  325.  
  326. Dave Trulli
  327. Usenet: nn2z@ka9q.bellcore.com
  328. packet: nn2z@nn2z
  329. AMPRNET: nn2z@nn2z.ampr [44.64.0.10]
  330.  
  331.